<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Manual Source Readme</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <style type="text/css"> 
.version {
    font-size: 10px;
}
.code {
    font-family: "Courier New", Courier, mono; color: #333333;
    background-color: #E0E8F0;
}
a:link, a:hover, a:visited, a:active {
    text-decoration: none;
    color: #0050A0;
}
h1 {
    font-size: 20px;
}
h2 {
    font-size: 18px;
    margin: 24px 0px 32px 0px;
    padding-left: 16px;  
    border-left: solid #0050A0 8px;
    position: relatve;
    left: 48px;
}
h3 {
    font-size: 15px;
}
body {
    background-color: #A0A0A0;
    text-align: center;
    padding: 0px;
}
#main {
    background-color: #FFFFFF;
    margin: 32px auto 32px auto;
    padding: 64px;
    font-size: 13px;
    max-width: 600px;
    font-family: "Trebuchet MS", Verdana, Arial, sanserif; color: #333333;    
    text-align: justify;
}
dt {
    font-weight: bold;
}
</style>
</head>
<body>
    <div id="main">
        <h1>
            Manual Source Readme</h1>
        <p>
            <span class="version">Version 1.7</span>
        </p>
        <h2>
            <a id="Introduction">Introduction</a>
        </h2>
        <p>
            These are the source files of the Crispy Plotter manual. The manual source itself
            is actually a PHP powered web site. PHP is used to build the manual layout, manage
            the page tree and generate the HTML files.
        </p>
        <h2>
            <a id="Information_for_Translators">Information for Translators</a></h2>
        <p>
            Each sub folder in <span class="code">/src</span> represents one language and contains
            all the files for a localized version of the manual. To translate the manual to
            a new language, just create a new folder in <span class="code">/src</span> and copy
            all contents from the "en"-folder into it. Rename your new folder to the ISO 639-1
            language code of your language (e.g. "de" for German). You can find a list with
            all language codes at <a href="http://www.loc.gov/standards/iso639-2/langhome.html">
                http://www.loc.gov/standards/iso639-2/langhome.html</a>.
        </p>
        <p>
            For a full translation of the manual, you need to perform the following steps:
        </p>
        <dl>
            <dt>Manual pages</dt>
            <dd>
                Each page of the manual is stored as an individual HTML file. Just translate each
                HTMl document to your language using your favourite text editor.
            </dd>
            <dt>Manual outline</dt>
            <dd>
                The outline captions of the manual are stored in consts.php. Translate them and
                set the language code from "en" to the ISO 639-1 language code of your language
                mentioned above.</dd>
            <dt>Manual figures</dt>
            <dd>
                If you like, you can also replace the figures containing English text with versions
                in your language. Of course for this, Crispy Plotter itself already needs to be
                available in your language.</dd>
        </dl>
        <h2>
            <a id="File_Structure">File Structure</a>
        </h2>
        <p>
            The page tree is stored as an array in <span class="code">pages.php</span>, which
            also contains functions for producing the table of contents, bread crumb paths,
            navigation links and other helpful stuff.
        </p>
        <p>
            The file <span class="code">view.php</span> defines the basic structure of a help
            page (header, content, footer, ...) and creates a help page by using the functions
            defined in <span class="code">pages.php</span>.
        </p>
        <p>
            You can view all manuals by opening the URL <a href="http://localhost/src/index.php">
                http://localhost/src/index.php</a> in your web browser, assuming that your web
            server is using the folder of this document as root directory (see also section
            "Export to HTML").
        </p>
        <h2>
            <a id="Export_To_HTML">Export To HTML</a>
        </h2>
        <p>
            The HTML pages generated by index.php can be exported to normal HTML files by using
            export.php. Keep in mind that you have to open export.php web page from a web server
            with PHP support (for example the XAMPP distribution, <a href="http://www.apachefriends.org">
                http://www.apachefriends.org</a>).
        </p>
        <p>
            When your web server is installed then set the document root to the folder containing
            this document or copy this folder to the document root. While your web server is
            running, you can open the export page at "<a href="http://localhost/src/export.php">http://localhost/src/export.php</a>"
            (assuming that you are running the web server on your own machine). The source folder
            and export folder should point to the correct location by default (<span class="code">src</span>
            and <span class="code">export</span>). Click on Export to export all localized manuals.
        </p>
    </div>
</body>
</html>
